home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / metkit / setup.exe / README.TXT < prev    next >
Text File  |  1997-06-08  |  12KB  |  237 lines
  1. The MetaKit Library 1.7             Copyright (C) 1996-1997 Meta Four Software
  2. ==============================================================================
  3.  
  4.  
  5. DESCRIPTION
  6.  
  7.     The MetaKit C++ classes implement highly-structured persistent containers.
  8.     This library can be used as an efficient database for many apps/utilities.
  9.     Some key features are: uncorruptable data files, an efficient file format,
  10.     "on-the-fly" restructuring, and portability - all using a very simple API.
  11.     
  12.     For an introduction to MetaKit, see the HTML info in the "docs" directory.
  13.     For a summary of changes in this release, see the "whatsnew.txt" file.
  14.  
  15.     This software can be freely downloaded for evaluation purposes. The full
  16.     C++ sources of MetaKit are available, there are no royalties involved.
  17.     Please read the disclaimer, which is in the file "include\m4kit.h".  
  18.  
  19.     The latest news can always be found at:     http://www.meta4.com/metakit/
  20.  
  21.  
  22. GETTING THE RIGHT PACKAGE
  23.  
  24.     The core distribution includes documentation, header files, sample code,
  25.     and executables with DLLs which will run on Windows 3.1x, 95, and NT.  If
  26.     you use MSVC 1.52 or 5.0, then you now have everything to try MetaKit in
  27.     your own applications (release build only, requires DLL versions of MFC).
  28.     The choice of MSVC/Windows is not an endorsement, it was selected because
  29.     that package is small and probably runs on "some computer near you". 
  30.  
  31.     As of this writing, MetaKit ports exist for Unix, Macintosh, VMS, MS-DOS,
  32.     and many Windows-hosted C++ development environments (Borland, Microsoft,
  33.     Powersoft, Symantec, Watcom).  New ports are announced on the website.
  34.  
  35.     For other compilers and/or platforms, you can download the library builds
  36.     from the web.  The MetaKit product range consists of five categories:
  37.  
  38.         1.  CORE distribution: docs, headers, sample code, Windows exe/dll's
  39.         2.  ADD-ON packages: platform/IDE-specific versions with libraries
  40.         3.  DEVELOPER releases: debug builds and static versions of the libs
  41.         4.  SOURCE code: complete source code of the library, with makefiles
  42.         5.  UNIVERSAL source: additional source code for non-MFC environments
  43.  
  44.     There are exactly 5 files in the CORE distribution:
  45.     
  46.         readme.txt      You are currently reading it...
  47.         whatsnew.txt    New features and changes in this release
  48.         order.txt       Order form, and details how to order on-line
  49.         setup.exe       Installs the MetaKit core package after confirmation
  50.         file_id.diz     Brief description, for automatic extraction
  51.  
  52.     Add-on packages for DOS/Win:
  53.  
  54.         m4kit17b.zip    Borland C++ 4.52 (Windows 16-bit)
  55.         m4kit17j.zip    DJ Delorie 2.0.1 (GNU C++ for MS-DOS)
  56.  
  57.     Add-on packages for other platforms use other archive formats, such as:
  58.  
  59.         m4kit17i.tgz    BSDI 2.1 Gnu C++ 2.7.2 (tar, gzipped)
  60.         m4kit17m.hqx    Mac Metrowerks Codewarrior 11 - 68K (stuffed, binhex)
  61.         m4kit17x.tgz    Linux ELF Gnu C++ 2.7.2 (tar, gzipped)
  62.  
  63.     Some of the add-ons include the core distribution to ease installation.
  64.     Distributions and ports can evolve quite rapidly, so be sure to check the
  65.     Metakit homepage on the web to make sure you have the latest release.  As
  66.     of this writing (June 1997), there were over a dozen developer releases.
  67.  
  68.  
  69. INSTALLING METAKIT
  70.  
  71.     To install the distribution files on Windows, just extract the "setup.exe"
  72.     program and run it.  After confirmation, all the files in the core package
  73.     will be copied to a directory (the default is C:\METAKIT).  Please do not
  74.     install this release over an earlier version of Metakit.
  75.  
  76.     The documentation for MetaKit is in HTML format, in the "docs" directory.
  77.     To use it, unzip the "M4KITDOC.ZIP" file, but please note that filenames
  78.     are longer than MS-DOS or Windows 3.1 can handle, and will be truncated.
  79.  
  80.     To install an ADD-ON package (after running "setup.exe"), you must extract
  81.     its files to a new subdirectory.  Then, move the DLL to the "bin" subdir,
  82.     and the import LIB to the "lib" subdirectory.  All add-ons use unique file
  83.     names, so you can install as many of them as you like.
  84.  
  85.     To uninstall MetaKit, simply delete the entire directory tree.  MetaKit
  86.     does not install hidden files, create "ini" files, or alter the registry.
  87.  
  88.     The standard or universal source code release must be installed ON TOP OF
  89.     the core distribution, they do not interfere with other installed add-ons.
  90.  
  91.     Installation on Unix and Macintosh is also very simple: just extract the
  92.     archive contents using standard utilities (tar / gzip, resp. StuffIt).
  93.  
  94.  
  95. ROADMAP
  96.  
  97.     The MetaKit core distribution creates the following sub-directories:
  98.  
  99.         bin\        Executables of the examples and DLL versions of MetaKit
  100.         docs\       Documentation in HTML format (see install notes above)
  101.         examples\   Source code examples (with MSVC 1.52 makefiles)
  102.         include\    Header files
  103.         lib\        Libraries needed to build applications
  104.  
  105.     Add-on packages for Windows contain only the extra files needed for their
  106.     respective environment (usually just a dll and an import library for it).
  107.     For Unix and Macintosh, add-ons also contain the header files and some
  108.     sample code, to avoid having to convert between different text formats.
  109.  
  110.     The developer releases all contain more library builds.  The DLL's can be
  111.     copied to the "bin" subdir, the static/import libraries can go to "lib".
  112.  
  113.     The source code releases of Metakit add the following sub-directories:
  114.         
  115.         include\    More headers, for optional inlined definitions (*.inl)
  116.         ports\      Notes and makefiles for several environments (universal)
  117.         regress\    Extensive regression-test sources with sample output
  118.         src\        Source code of MetaKit (C++ files and private headers)
  119.  
  120.     And also:
  121.         
  122.         msvc16\     Project files to build all MSVC / Win 16 configurations
  123.         msvc32\     Project files to build all MSVC / Win 32 configurations
  124.         ..etc..\    More project files and make/IDE-related files (universal)
  125.  
  126.  
  127. CONFIGURATIONS
  128.  
  129.     Developer releases are available to all registered users, and contain a
  130.     wide range of libraries: debug vs. release builds, static vs. dynamic, and
  131.     a choice of underlying framework (MFC, STL/string/stdio, or "universal").
  132.  
  133.     As of version 1.7, Metakit supports using any of the above configurations,
  134.     (as far as supported by the environment of course).  It's even possible to
  135.     use the "standard" or "universal" configurations of MetaKit in combination
  136.     with MFC, simply by adding a "#define q4_STD 1" or "#define q4_UNIV 1".
  137.  
  138.  
  139. PORTABILITY
  140.  
  141.     This release has been tested with a very wide range of compilers and has
  142.     been compiled on platforms ranging from small-model Intel (MS-DOS) to the
  143.     64-bit Dec Alpha (Unix as well as OpenVMS).  All builds are based on the
  144.     same source code, and the datafiles are portable between all platforms.
  145.  
  146.     On those platforms that support it, the library can be built as either a
  147.     static library or a dynamic DLL (shared library).
  148.  
  149.     Also, on those platforms that support it (currently Unix and Win 95/NT),
  150.     memory mapped files are used to greatly reduce memory usage during access.
  151.  
  152.     The library code can use STL and/or MFC classes if available, but will
  153.     work even if the compiler doesn't support templates, exceptions, or RTTI.
  154.     MetaKit does not impose restrictions if *you* wish to use any of these.
  155.  
  156.     All C++ identifiers with global scope include the digit four. Namespace
  157.     support will be added when this addition to C++ becomes more widespread.
  158.  
  159.     Support for other compilers, frameworks, hardware, and operating systems
  160.     will be added when needed, new ports usually require very little effort.
  161.  
  162.  
  163. REGISTRATION
  164.  
  165.     The MetaKit Library is not free, you must register for US$ 25 if you use
  166.     this code in your own software after an eva